package com.dragon.linkedlist;

/**
 * 虚拟头结点链表
 *
 * @author dragon
 * @version 1.0
 * @description 虚拟头节点的链表
 * @date created in 2018-12-17
 */
public class DummyHeadLinkedList<E> {

    /**
     * 虚拟头节点
     */
    private Node dummyHead;

    /**
     * 链表元素数量
     */
    private int size;

    private static class Node<E> {
        E item;

        Node<E> next;

        Node(E item, Node<E> next) {
            this.item = item;
            this.next = next;
        }
    }

    /**
     * 构造函数
     */
    public DummyHeadLinkedList() {
        dummyHead = new Node(null, null);
        size = 0;
    }

    /**
     * 在指定的角标处添加元素
     *
     * @param index 将要被插入的元素的位置
     * @param e     添加的元素
     */
    public void add(int index, E e) {
        if (index < 0 || index > size) {
            throw new IllegalArgumentException("add failed,index out of bounds:" + index);
        }
        Node prev = dummyHead;
        for (int i = 0; i < index; i++) {
            prev = prev.next;
        }
        prev.next = new Node<E>(e, prev.next);
        size++;
    }

    /**
     * 往链表的头部添加元素
     *
     * @param e
     */
    public void addFirst(E e) {
        add(0, e);
    }

    /**
     * 往链表的尾部添加元素
     *
     * @param e
     */
    public void addLast(E e) {
        add(size, e);
    }

    /**
     * 删除指定角标处的元素
     *
     * @param index 指定的角标处
     * @return 返回之前被删除的元素
     */
    public E remove(int index) {
        if (index < 0 || index >= size) {
            throw new IllegalArgumentException("remove failed,index out of bounds:" + index);
        }
        Node prev = dummyHead;
        for (int i = 0; i < index; i++) {
            prev = prev.next;
        }
        Node<E> cur = prev.next;
        prev.next = cur.next;
        cur.next = null;
        size--;
        return cur.item;
    }

    /**
     * 在角标处替换元素
     *
     * @param index 元素将被替换的索引
     * @param e     在该角标处被存储的元素
     * @return 返回被替换的元素
     */
    public E set(int index, E e) {
        if (index < 0 || index >= size) {
            throw new IllegalArgumentException("set failed,index out of bounds:" + index);
        }
        Node<E> cur = null;
        for (int i = 0; i <= index; i++) {
            cur = dummyHead.next;
        }
        E oldVal = cur.item;
        cur.item = e;

        return oldVal;
    }

    /**
     * 通过角标找到对应的节点元素
     *
     * @param index
     * @return
     */
    public E get(int index) {
        if (index < 0 || index >= size) {
            throw new IllegalArgumentException("get failed,index out of bounds:" + index);
        }
        Node<E> cur = this.dummyHead.next;
        for (int i = 0; i < index; i++) {
            cur = cur.next;
        }
        return cur.item;
    }

    /**
     * 判断链表是否为空链表
     *
     * @return
     */
    public boolean isEmpty() {
        return size == 0;
    }

    /**
     * 得到链表的元素个数
     *
     * @return
     */
    public int size() {
        return size;
    }

    /**
     * 重写toString方法
     *
     * @return
     */
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("head");
        for (Node<E> cur = dummyHead.next; cur != null; cur = cur.next) {
            sb.append(cur.item + "->");
        }
        sb.append("NULL\n");
        sb.append("size:" + size);
        return sb.toString();
    }
}
